<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>runcrawler</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >MetaGETA (Metadata Gathering, Extraction and Transformation)</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Module&nbsp;runcrawler
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="runcrawler-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module runcrawler</h1><p class="nomargin-top"><span class="codelink"><a href="runcrawler-pysrc.html">source&nbsp;code</a></span></p>
<p>Script to run the MetaGeta Metadata Crawler</p>
  <p>Contains code to show GUI to gather input arguments when none are 
  provided To run, call the eponymous batch file/shell script which sets 
  the required environment variables</p>
  <p>Usage:</p>
<pre class="literalblock">
   runcrawler.bat/sh -d dir -x xls -s shp -l log {-o} {--nogui} {--debug}
</pre>

<hr />
<div class="fields">      <strong>Arguments:</strong>
      <ul class="nomargin-top">
        <li>
        <code>-d [dir]</code>        : Directory to to recursively search 
        for imagery
        </li>
        <li>
        <code>-x [xls]</code>        : MS Excel spreadsheet to write 
        metadata to
        </li>
        <li>
        <code>-m, --mediaid</code>   : CD/DVD media ID, defaults to volume 
        label.
        </li>
        <li>
        <code>-u, --update</code>    : Update previous crawl results.
        </li>
        <li>
        <code>-o, --overviews</code> : Generate overview 
        (quicklook/thumbnail) images&quot;)
        </li>
        <li>
        <code>--nogui</code>         : Don't show the GUI progress 
        dialog&quot;)
        </li>
        <li>
        <code>--debug</code>         : Turn debug output on
        </li>
      </ul>
      <p><strong>Note:</strong>
        See <a href="http://code.google.com/p/metageta/issues/detail?id=22"
        target="_top">Issue 22</a>
      </p>
</div><!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="runcrawler-module.html#main" class="summary-sig-name">main</a>(<span class="summary-sig-arg">dir</span>,
        <span class="summary-sig-arg">xls</span>,
        <span class="summary-sig-arg">mediaid</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">update</span>=<span class="summary-sig-default">False</span>,
        <span class="summary-sig-arg">getovs</span>=<span class="summary-sig-default">False</span>,
        <span class="summary-sig-arg">nogui</span>=<span class="summary-sig-default">True</span>,
        <span class="summary-sig-arg">debug</span>=<span class="summary-sig-default">False</span>,
        <span class="summary-sig-arg">pl</span>=<span class="summary-sig-default">None</span>)</span><br />
      Run the Metadata Crawler</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="runcrawler-pysrc.html#main">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="exit"></a><span class="summary-sig-name">exit</span>()</span><br />
      Force exit after closure of the ProgressBar GUI</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="runcrawler-pysrc.html#exit">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Variables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="None">None</code>
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="main"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">main</span>(<span class="sig-arg">dir</span>,
        <span class="sig-arg">xls</span>,
        <span class="sig-arg">mediaid</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">update</span>=<span class="sig-default">False</span>,
        <span class="sig-arg">getovs</span>=<span class="sig-default">False</span>,
        <span class="sig-arg">nogui</span>=<span class="sig-default">True</span>,
        <span class="sig-arg">debug</span>=<span class="sig-default">False</span>,
        <span class="sig-arg">pl</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="runcrawler-pysrc.html#main">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Run the Metadata Crawler</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>dir</code></strong> (<code>str</code>) - The directory to start the metadata crawl.</li>
        <li><strong class="pname"><code>xls</code></strong> (<code>str</code>) - Excel spreadsheet to write metadata to</li>
        <li><strong class="pname"><code>mediaid</code></strong> (<code>str</code>) - CD/DVD media ID</li>
        <li><strong class="pname"><code>getovs</code></strong> (<code>boolean</code>) - Generate overview (quicklook/thumbnail) images</li>
        <li><strong class="pname"><code>nogui</code></strong> (<code>boolean</code>) - Don't show the GUI progress dialog</li>
        <li><strong class="pname"><code>debug</code></strong> (<code>boolean</code>) - Turn debug output on</li>
        <li><strong class="pname"><code>pl</code></strong> (<code>progresslogger.ProgressLogger</code>) - Use an already instantiated logger</li>
    </ul></dd>
    <dt>Returns:</dt>
        <dd><code>progresslogger.ProgressLogger</code></dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >MetaGETA (Metadata Gathering, Extraction and Transformation)</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    &nbsp;
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
